Retrieve Performance Metrics Information Based on Widget ID

GET 
/query/visualization/:id

Call this API to retrieve the Key Performance Indicators (KPIs) for a specific widget. The 'id' parameter must be provided to specify the widget of a dashboard for which you want to retrieve the KPIs. The metrics details returned will be based on the timeline selected in the widget. You can also fetch historical data by selecting the appropriate timeline in the widget from the UI, enabling a detailed analysis over different periods. This endpoint can only be used to retrieve performance metrics for the following widget types: Chart (Available for Metric, Availability, and Alert data types), Grid, Stream, and Active Alert.

Request

Path Parameters

id integerrequired

Unique identifier for the widget. This widget ID is required to fetch the corresponding performance metrics and their values from the widgets.

Query Parameters

discard.dummy.rows string

Indicates whether to discard rows with dummy values in the performance metrics. The default value is `yes'. You can leave this unchanged.

Responses

200

Successful response. The request was successful, and the performance metrics for the specified widget ID were returned. The response schema will vary depending on the type of counter (Scalar or Instance).

application/json

Schema

Schema

oneOf
Performance_Metrics_Details_Scalar_Counter_Response
response-code integer
status string
result object[]
Array [
monitor string
system.cpu.percent^max integer
]
Performance_Metrics_Details_Instance_Counter_Response
response-code integer
status string
result object[]
Array [
monitor string
interface string
interface~sent.discard.packets^last integer
]

Example (from schema)

{}

400

Bad request. The request was malformed or contains invalid parameters. The client should correct the request and try again.

application/json

Schema

Schema

response-code integer
status string
errors object[]
Array [
error string
error.code string
message string
]

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "errors": [
    {
      "error": "Failed to execute query for widget Preview Widget, Possible reason: No entity qualified",
      "error.code": "MD031",
      "message": "Failed to execute query for widget Preview Widget, Possible reason: No entity qualified"
    }
  ]
}

403

Request Forbidden. The request was forbidden. The client does not have permission to access this resource.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

408

Timed out. The request timed out. This usually happens when the server takes too long to process the request.

application/json

Schema

Schema

response-code integer
status string
errors object[]
Array [
error string
error.code string
message string
]

Example (from schema)

{
  "response-code": 408,
  "status": "timeout",
  "errors": [
    {
      "error": "Timed out",
      "error.code": "MD004",
      "message": "Timed out"
    }
  ]
}

500

Internal server error. An internal server error occurred while processing the request.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...